<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Configuration</title><link rel="stylesheet" type="text/css" href="../severin.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"/><link rel="home" href="index.xhtml" title="Severin"/><link rel="up" href="index.xhtml" title="Severin"/><link rel="prev" href="ch01.xhtml" title="Overview"/><link rel="next" href="ch03.xhtml" title="How to use"/></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">
			
			<span xml:lang="en" class="phrase">Configuration</span>
		</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01.xhtml">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch03.xhtml">Next</a></td></tr></table></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="d6e82"/>
			
			<span xml:lang="en" class="phrase">Configuration</span>
		</h1></div></div></div>
		
		<div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="d6e85"/>
				
				<span xml:lang="en" class="phrase">configurations files</span>
			</h2></div></div></div>
			
			
			<p xml:lang="en">During the first start the plugin creates two configuration files in 
				<code class="filename">$USERHOME\OxygenExtension\SeverinImageViewer</code>.</p>
			<div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="default-image-paths"/>
					
					<span xml:lang="en" class="phrase">Default Image Paths (<code class="filename">lastImgPaths.txt</code>)</span>
				</h3></div></div></div>
				
				<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
						
						<p xml:lang="en">You can insert frequently used image paths in the file <code class="filename">lastImgPaths.txt</code>.</p>
					</li><li class="listitem">
						
						<p xml:lang="en">The image path is the root for all images in the XML or in the project. </p>
					</li><li class="listitem">
						
						<p xml:lang="en">Per row is only one image path allowed.</p>
					</li><li class="listitem">
						
						<p xml:lang="en">After inserting a new image path, you have to restart &lt;oXygen/&gt;.</p>
					</li></ul></div>
			</div>
			<div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="d6e104"/>
					
					<span xml:lang="en" class="phrase">Automatic Image Viewer (<code class="filename">knownDatamodels.xml</code>)</span>
				</h3></div></div></div>
				
				
				<p xml:lang="en">The context sensitive update of the image viewer paneel needs informations about the context for the search after image references.
					These informations (data models) are saved in <code class="filename">knownDatamodels.xml</code>.</p>
				
				<p xml:lang="en">Every XML data model needs its own configuration section (<code class="code">knownDatamodel</code>).</p>
				<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
						
						<p xml:lang="en"><code class="code">&lt;xmlFormat/&gt;</code>: name of a data model or a project, e.g. TEI.</p>
					</li><li class="listitem">
						
						<p xml:lang="en"><code class="code">&lt;cssRootElement/&gt;</code>: name of the element which framing a data set with its image reference, e.g. <code class="code">&lt;ead:did&gt;</code> or <code class="code">&lt;tei:pb&gt;</code></p>
					</li><li class="listitem">
						
						<p xml:lang="en"><code class="code">&lt;imageReferenceFields/&gt;</code>: contains list of image references</p>
						<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">
								
								<p xml:lang="en"><code class="code">&lt;imageReferenceField/&gt;</code>: contains an image reference</p>
								<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: square; "><li class="listitem">
										
										<p xml:lang="en"><code class="code">&lt;name/&gt;</code>: name of the XML-node containing the path to the image</p>
									</li><li class="listitem">
										
										<p xml:lang="en"><code class="code">&lt;fileType/&gt;</code>: type of the image path (<code class="code">FILE</code> or <code class="code">DIR</code>)</p>
									</li><li class="listitem">
										
										<p xml:lang="en"><code class="code">&lt;xmlType/&gt;</code>: type of the XML-node containing the path to the image (<code class="code">ELEMENT</code> or <code class="code">ATTRIBUTE</code>)</p>
									</li></ul></div>
							</li></ul></div>
					</li></ul></div>	
				
				<p xml:lang="en">Now two examples. First <a class="ulink" href="http://www.tei-c.org" target="_top">TEI - Text Encoding Initiative</a>:</p>
				<div class="literallayout"><p>&lt;knownDatamodel&gt;<br/>
	&lt;xmlFormat&gt;tei&lt;/xmlFormat&gt;<br/>
	&lt;cssRootElement&gt;pb&lt;/cssRootElement&gt;<br/>
	&lt;imageReferenceFields&gt;<br/>
		&lt;imageReferenceField&gt;<br/>
			&lt;name&gt;facs&lt;/name&gt;<br/>
			&lt;fileType&gt;FILE&lt;/fileType&gt;<br/>
			&lt;xmlType&gt;ATTRIBUTE&lt;/xmlType&gt;<br/>
		&lt;/imageReferenceField&gt;<br/>
	&lt;/imageReferenceFields&gt;<br/>
&lt;/knownDatamodel&gt;</p></div>
				
				<p xml:lang="en">If you use namespace prefixes, then you have to specify them as in the xml file:</p>
				<div class="literallayout"><p>&lt;knownDatamodel&gt;<br/>
	&lt;xmlFormat&gt;TEI with prefix&lt;/xmlFormat&gt;<br/>
	&lt;cssRootElement&gt;tei:pb&lt;/cssRootElement&gt;<br/>
	&lt;imageReferenceFields&gt;<br/>
		&lt;imageReferenceField&gt;<br/>
			&lt;name&gt;facs&lt;/name&gt;<br/>
			&lt;fileType&gt;FILE&lt;/fileType&gt;<br/>
			&lt;xmlType&gt;ATTRIBUTE&lt;/xmlType&gt;<br/>
		&lt;/imageReferenceField&gt;<br/>
	&lt;/imageReferenceFields&gt;<br/>
&lt;/knownDatamodel&gt;</p></div>
				
				<p xml:lang="en">And now a second example for <a class="ulink" href="http://www.loc.gov/ead/" target="_top">EAD - Encoded Archival Description</a>: </p>
				<div class="literallayout"><p>&lt;knownDatamodel&gt;<br/>
	&lt;xmlFormat&gt;ead&lt;/xmlFormat&gt;<br/>
	&lt;cssRootElement&gt;did&lt;/cssRootElement&gt;<br/>
	&lt;imageReferenceFields&gt;<br/>
		&lt;imageReferenceField&gt;<br/>
			&lt;name&gt;xlink:href&lt;/name&gt;<br/>
			&lt;fileType&gt;FILE&lt;/fileType&gt;<br/>
			&lt;xmlType&gt;ATTRIBUTE&lt;/xmlType&gt;<br/>
		&lt;/imageReferenceField&gt;<br/>
	&lt;/imageReferenceFields&gt;<br/>
&lt;/knownDatamodel&gt;</p></div>
				
				<p xml:lang="en">These data models are preconfigured within the plugin.</p>
				
				
				<p xml:lang="en">For the manual triggered image view is no configuration required.</p>
				
			</div>
		</div>
	</div><div class="navfooter"><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01.xhtml">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch03.xhtml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">
        	
        	<span xml:lang="en" class="phrase">Overview</span>
         </td><td width="20%" align="center"><a accesskey="h" href="index.xhtml">Home</a></td><td width="40%" align="right" valign="top"> 
			
			<span xml:lang="en" class="phrase">How to use</span>
		</td></tr></table></div></body></html>